/* 
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.  
*/
package erwiki.api.parser;

import org.elwiki_data.WikiPage;
import org.jdom2.Document;

/**
 * Хранит дерево DOM отображаемой вики-страницы. Этот класс расширяет org.jdom.Document для
 * предоставления некоторых дополнительных метаданных, специальных для ErWiki.
 * <p>
 * Документ не хранится в виде метаданных на Вики-странице, иначе, его нельзя было бы кэшировать как
 * отдельный элемент.
 */
public class WikiDocument extends Document {

	private static final long serialVersionUID = 1L;

	private final WikiPage wikiPage;
	private String wikiText;

	/**
	 * Создает новый WikiDocument для заданной страницы.
	 * 
	 * @param page Страница, на которую ссылается этот документ.
	 */
	public WikiDocument(final WikiPage page) {
		this.wikiPage = page;
	}

	/**
	 * Устанавливает текст, связанный с этим документом.
	 * 
	 * @param text Заданный текст.
	 */
	public void setPageData(final String text) {
		this.wikiText = text;
	}

	/**
	 * Возвращает текст, связанный с этим документом.
	 * 
	 * @return Используемый текст.
	 */
	public String getPageData() {
		return this.wikiText;
	}

	/**
	 * Возвращает WikiPage, для которой определен этот WikiDocument.
	 * 
	 * @return Страница WikiPage.
	 */
	public WikiPage getPage() {
		return this.wikiPage;
	}

}
